home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / misc / hhelp10.zip / HHELP.DOC < prev    next >
Text File  |  1994-07-10  |  13KB  |  314 lines
  1.  
  2.  
  3.  
  4.                   Manual for HHELP Version 1.0
  5.                              July 1994
  6.  
  7.  
  8.        -------------------------------------------------------
  9.           HHELP is Copyright (c) 1994. All Rights Reserved
  10.                     Adlersparre & Associates Inc.
  11.                       304-1803 Douglas Street,
  12.                            Victoria, BC,
  13.                           Canada, V8T 5C3
  14.  
  15.              Phone: (604) 384-1118  Fax: (604) 384-3363
  16.                  Email: uf499@freenet.victoria.bc.ca
  17.  
  18.                        Bulletin Board Support:
  19.                        ----------------------
  20.  
  21.                 Management Advancement Services (MAS)
  22.                             New York City
  23.                         Modem: (718) 444-4555
  24.  
  25.                     Adlersparre & Associates Inc.
  26.                             Victoria, BC
  27.                         Modem: (604) 384-3564
  28.  
  29.  
  30.      Product support is available through Email, BBS or FAX only
  31.  
  32.  
  33.  
  34.   HHELP Overview
  35.   --------------
  36.  
  37.         HHELP is a DOS program which will display Windows 3.1
  38.         format help files without Windows (or in a DOS box
  39.         running in Windows). HHELP supports hypertext jumps,
  40.         popups, keyword search, bookmarks, and multiple help
  41.         files (selectable from a menu).  You can launch your
  42.         favorite graphics display program to present graphic
  43.         images from wherever you wish in the text.  Includes
  44.         screen capture functions and mouse support.  You can
  45.         use HHELP to display your own help files.  You can
  46.         also display them from within your favorite applica-
  47.         tions or from within your own software.
  48.  
  49.  
  50.   This manual is for the evaluation release of HHELP.EXE. The evalua-
  51.   tion version is fully featured with no disabled functions. If after 30
  52.   days of evaluation you decide to continue to use the product, you must
  53.   register HHELP. The cost is $35.00 (US). You will receive the current
  54.   NON-EVALUATION version of HHELP, a help file containing full
  55.   documentation, and several useful help files which may be used under
  56.   Windows or with HHELP under DOS.
  57.  
  58.   Corporate and Government site licenses are available for HHELP and
  59.   must be obtained for the use of HHELP in any organization.
  60.  
  61.  
  62.   HHELP Features
  63.   --------------
  64.  
  65.   HHELP is a DOS program which will display Windows 3.1 format help
  66.   files in text mode under DOS without Windows or in a DOS box running
  67.   in Windows.
  68.  
  69.   HHELP will read and display almost any Windows help file created with
  70.   the HC31.EXE or HCP.EXE help compilers.
  71.  
  72.   HHELP supports many of the help features found in the WINHELP Windows
  73.   utility, such as jumps, popups, keyword search, bookmarks, and
  74.   multiple help files.
  75.  
  76.   HHELP supports text, not graphics. HHELP does not support external
  77.   GLOSSARY files or non-scrolling text regions. You can, however define
  78.   hotspots in a help file which will trigger HHELP to load and execute a
  79.   graphics viewer program of your choice. A sample viewer with a .GIF
  80.   image is provided as a demonstration.
  81.  
  82.   HHELP captures the current screen when invoked, and will also allow
  83.   you to load a data file. In the screen and data file windows, HHELP
  84.   senses words or phrases which match those in the internal help file
  85.   keyword list as the mouse is moved over them.
  86.  
  87.   You can click the left button on a data screen and go immediately to
  88.   the help topic, or click the right button and go into the search menu
  89.   to the closest keyword phrase match. Thus you have true context
  90.   sensitive help.
  91.  
  92.  
  93.   Installation
  94.   ------------
  95.  
  96.   You should run the INSTALL.EXE program supplied with HHELP to install
  97.   the software for you.
  98.  
  99.   The install program will ask if it is ok to add C:\HHELP to your PATH
  100.   statement in AUTOEXEC.BAT. If this is done, all the files copied into
  101.   C:\HHELP can remain there. If not, you must move the files to subdirec-
  102.   tories in your PATH, or you must make C:\HHELP your current directory
  103.   before starting HHELP. In any case, the HHELP.INI file MUST be located
  104.   in C:\HHELP for this evaluation to work, even if C:\HHELP is not added
  105.   to your path.
  106.  
  107.   For this evaluation version, all HHELP related files must exist in the
  108.   subdirectory C:\HHELP which will be created by the INSTALL program.
  109.  
  110.  
  111.   The HHELP related files which reside in C:\HHELP are:
  112.  
  113.      HHELP.EXE     the hhelp program
  114.      HHLOAD.EXE    the TSR to invoke HHELP
  115.      AVLOAD.EXE    the TSR to invoke graphics viewer(s)
  116.      HVIEW.EXE     a sample graphic viewer from A&A Inc.
  117.      HHELP.INI     the HHELP configuration file
  118.      HH.BAT        a sample batch file to load the TSRs
  119.      HHU.BAT       a sample batch file to unload the TSRs
  120.      HHELP.HLP     a help file containing information on using HHELP
  121.      FIRSTAID.HLP  a sample help file for Windows or HHELP
  122.      IMAGE.GIF     a sample graphic for viewing .PCX or .GIF files
  123.      HHELP.DOC     this file you are reading
  124.  
  125.  
  126.   Customizing HHELP with the HHELP.INI File
  127.   -----------------------------------------
  128.  
  129.   You can define HHELP's Categories, Help Files, Search Paths and
  130.   Graphics Viewers by editing the HHELP.INI file:
  131.  
  132.   Help files are located in subdirectories of your choice and are
  133.   defined in the [MenuPath] section in HHELP.INI.
  134.  
  135.   Graphics files are located in subdirectories of your choice and are
  136.   defined in the [GraphicsPath] section in HHELP.INI.
  137.  
  138.   Any graphics viewer programs you will be using are defined in the
  139.   [Viewers] section of the HHELP.INI file. You MUST have the AVLOAD
  140.   and HHLOAD TSR programs loaded in memory for the graphics viewer
  141.   programs to work.
  142.  
  143.   You should read through the comments in the supplied HHELP.INI file
  144.   and modify this file to suit your requirements.
  145.  
  146.   In order to take advantage of loading viewers and displaying graphics,
  147.   you must create your own help files with special hotspots defined.
  148.   These are not the jump or popup hotspots found in Windows help files,
  149.   but are defined as words in bright magenta. Each word is the name of a
  150.   file, without the extension, prefixed with a special character which
  151.   identifies its graphics viewer.
  152.  
  153.  
  154.   * Important Note * - In order to minimize the use of conventional or
  155.   upper memory, it is recommended that LIM Expanded memory be made
  156.   available. This reduces the size of the AVLOAD and HHLOAD TSR
  157.   programs considerably, since when not in use, they reside there.
  158.  
  159.  
  160.   Getting Started
  161.   ---------------
  162.  
  163.   There are two TSR programs (AVLOAD.EXE and HHLOAD.EXE) which can be
  164.   used to load the HHELP program whenever you press ALT+?. But you don't
  165.   have to use them right away. To test HHELP you can run it from the DOS
  166.   command line and specify a help file. This will skip reading the
  167.   HHELP.INI file. Use the DOS command:
  168.  
  169.                        HHELP C:\HHELP\HHELP.HLP
  170.  
  171.   In order to display graphics with the graphics viewer, you must
  172.   load AVLOAD and HHLOAD into memory before starting HHELP.  If they
  173.   are loaded, HHELP may be run from the DOS command line or started
  174.   with the ALT+? keys, and the graphics will be displayed when selec-
  175.   ted as hotspots.
  176.  
  177.   The two TSRs are loaded in memory (conventional or upper memory) as
  178.   per the example in HH.BAT supplied. Each TSR takes about 1400 bytes.
  179.   They MUST be loaded in the order shown in the HH.BAT sample batch
  180.   file, using the parameters shown. The must also be unloaded in the
  181.   order shown in the HHU.BAT sample batch file.
  182.  
  183.   To invoke the HHELP program, press ALT+?. This will swap out the
  184.   current application and load the HHELP program.  A mouse is needed
  185.   to use HHELP.
  186.  
  187.   Press ALT+H and H to load a HELP ON HELP help file which will assist
  188.   you in navigating through the windows. If you are familiar with
  189.   Windows, you already know how to use HHELP. The help on help file is
  190.   included and is called HHELP.HLP.
  191.  
  192.   Go through the tutorial in the HELP ON HELP file to see more options
  193.   and keys you can use.
  194.  
  195.   To exit HHELP and return to the application, or to the DOS command
  196.   line, press ALT+X.
  197.  
  198.  
  199.   How Is HHELP Used
  200.   -----------------
  201.  
  202.   HHELP can be started from the DOS command line or through the use of
  203.   the memory resident HHLOAD.EXE TSR program which requires about 1400
  204.   bytes. If you are using the graphics display feature in HHELP, you
  205.   will also need to load the memory resident AVLOAD.EXE TSR program
  206.   which will need about 1400 bytes also.
  207.  
  208.   Using HHELP from the DOS command line is simply a matter of entering
  209.   the HHELP command. A menu is presented from the HHELP.INI file
  210.   specifications which allows you to select a help file.
  211.  
  212.   You can also include the name of a help file on the command line which
  213.   will bypass the first menu and go immediately into the named help
  214.   file. While using the help file, you can press F1 and get the original
  215.   menu of help files so you can open and use more than one help file
  216.   simultaneously.
  217.  
  218.   HHELP is invoked by a TSR program which activates with ALT+? to swap
  219.   the current application to EMS, XMS or DISK, capture the current
  220.   screen and invoke the help facility. The HHELP= environment variable
  221.   may be set so that a given .HLP help file is automatically invoked,
  222.   such as SET HHELP=FIRSTAID to invoke the FIRSTAID.HLP file.
  223.  
  224.   You can even use the ALT+? keystrokes while under Windows in a DOS box
  225.   to invoke HHELP.
  226.  
  227.   The Categories, Help Files, Search Paths and Graphics Viewers are
  228.   defined in a file called HHELP.INI.
  229.  
  230.  
  231.   How to Find Out More About HHELP
  232.   --------------------------------
  233.  
  234.   After you have installed HHELP, review the HHELP.HLP help file. It
  235.   contains a tutorial and many helpful hints on using windows, keys,
  236.   bookmarks, search keys and other HHELP features.
  237.  
  238.   Note the option in the HH.BAT batch file which will let HHELP run
  239.   in 50-line mode (if your monitor supports this mode). Showing more
  240.   text on the screen makes reading the tutorial easier.
  241.  
  242.  
  243.   How to Create Help Files
  244.   ------------------------
  245.  
  246.   There are some commercial programs available to assist with creating
  247.   help files. ROBOHELP and Help Magician are both examples of programs
  248.   for this purpose. They create Windows help files, but the files they
  249.   create can usually be displayed by HHELP under DOS without Windows.
  250.  
  251.   There are also some new and exciting shareware programs which will
  252.   assist you in creating Windows help files which HHELP will also be
  253.   able to process. HHELP will process version 3.1 or later files.
  254.  
  255.   You can also manually create help files using Word for Windows and a
  256.   Visual Basic manual. That method is somewhat slower than using a
  257.   program which can automate the process.
  258.  
  259.   You can display most Windows help files with HHELP, but the real use
  260.   of this product is for displaying your own help files.
  261.  
  262.   You can take advantage of the quick and easy display functions under
  263.   DOS. This would be a great way to turn those old 286 and 386 machines
  264.   into user friendly workstations.
  265.  
  266.   Using HHELP you can create help files which run on top of any
  267.   application but do not require any changes to the application. Since
  268.   HHELP displays the screen or any data file, you can have immediate
  269.   context sensitive help for any application.
  270.  
  271.   Since HHELP will load graphics viewers, you can integrate help into
  272.   imaging or GIS programs.
  273.  
  274.  
  275.   Other Products From Adlersparre & Associates Inc.
  276.   -------------------------------------------------
  277.  
  278.   We are the creators of:
  279.  
  280.   STASH Disk Filer      Cross platform data compression for:
  281.   ----------------      UNIX, DOS, OS/2, MVS, VM, VMS, VSE,
  282.                         AS/400, UNISYS, ICL and others.
  283.  
  284.   Stash provides complete ultra fast data compression and data
  285.   conversion with utilities and libraries for most platforms.
  286.  
  287.   Wylbur/AT             Text editor and programmable system for DOS
  288.   ---------             and OS/2.
  289.  
  290.   Wylbur/AT is very close in functionality to the mainframe Wylbur
  291.   product, providing screen edit commands and programmable EXEC files
  292.   which are almost completely compatible with the mainframe.
  293.  
  294.   Wylbur/AT provides an English language command set to create
  295.   application programs with an interactive user interface.
  296.  
  297.   Dynamic Memory Control     DOS utilities for loading and removing
  298.   ----------------------     Device Drivers and TSR programs.
  299.  
  300.   DMC provides the ability to load and remove Device Drivers and
  301.   memory resident programs without rebooting. Loads ramdrives, network
  302.   drivers and a host of other drivers normally used in CONFIG.SYS, but
  303.   lets you unload them again even from a batch file.
  304.  
  305.   Help Files
  306.   ----------
  307.  
  308.   We are also specialists in writing and formatting help files and Visual
  309.   Basic applications using the latest imaging and scanning graphics
  310.   presentation tools. Please contact us to discuss your help file and
  311.   technical writing requirements.
  312.  
  313.  
  314.